home *** CD-ROM | disk | FTP | other *** search
/ Shareware Grab Bag / Shareware Grab Bag.iso / 002 / tspell.arc / TSPELL.DOC < prev   
Encoding:
Text File  |  1986-07-14  |  10.5 KB  |  361 lines
  1.  
  2.  
  3.  
  4.  
  5.                            Turbo Spell User's Guide
  6.  
  7.  
  8.  
  9.  
  10.  
  11.  
  12.  
  13.  
  14.                        Turbo Spell - The Spelling Checker
  15.  
  16.                                   Version 1.2
  17.  
  18.                            Released January 25, 1986
  19.  
  20.         (c)Copyright 1985, 1986 by Roger Egeberg.  All rights reserved.
  21.  
  22.  
  23.  
  24.   Program Description:
  25.  
  26.     Turbo  Spell  is  a  spelling  checker  written  for  the  IBM  PC  and
  27.     compatibles.  It  was  written  with  Turbo  Pascal  Version  3.0.  The
  28.     dictionary currently has about 9300 words.  Another 1000 words  can  be
  29.     saved  in  a  temporary extra words list.  This extra words list can be
  30.     permanently combined into the main dictionary at any time.
  31.  
  32.  
  33.  
  34.  
  35.  
  36.  
  37.  
  38.  
  39.  
  40.  
  41.  
  42.  
  43.  
  44.  
  45.  
  46.  
  47.  
  48.  
  49.  
  50.  
  51.  
  52.  
  53.  
  54.  
  55.  
  56.  
  57.  
  58.  
  59.  
  60.                                     Page 1    
  61.  
  62.  
  63.  
  64.  
  65.                            Turbo Spell User's Guide
  66.  
  67.  
  68.  
  69.  
  70.   Distribution Agreement:
  71.  
  72.     Individuals,  clubs,  and  other  non-profit  organizations are granted
  73.     permission by the author to freely copy the  Turbo  Spell  program  and
  74.     documentation  as long as they are not modified in any way and they are
  75.     distributed together.  No price or other consideration may be  charged,
  76.     other than a reasonable fee for copying and shipping ($7.00 maximum).
  77.  
  78.  
  79.   Author:    Roger Egeberg
  80.              PO Box 65
  81.              Argusville, ND 58005
  82.  
  83.  
  84.   Acknowledgements:
  85.  
  86.     1.)  The window/menu routines were adapted from those originally
  87.          written and modified by Barry Abrahamsen and Philip R. Burns.
  88.  
  89.     2.)  Part of the word list for the dictionary came from an ASCII
  90.          file spell checker called SPELLER, written by John Leeson.
  91.  
  92.  
  93.  
  94.   System Requirements:  IBM-PC or compatible MS-DOS computer
  95.                         192K or more RAM
  96.                         PC/MS-DOS 2.xx
  97.                         Color graphics or monochrome display card
  98.  
  99.  
  100.   Inquiries:
  101.  
  102.     Inquiries may be sent to me at the address above or may be left on the
  103.     following BBS's:
  104.  
  105.               Fargo IBM PC Users Group BBS       (701) 293-5973
  106.               HECN BBS                           (701) 232-2787
  107.  
  108.     The most recent version of the program will usually be on the Fargo IBM
  109.     PC  Users  Group BBS,  and on the others as time permits.  You are also
  110.     encouraged to send your bug reports or suggestions for improvements  to
  111.     me on the above BBS's.
  112.  
  113.  
  114.  
  115.  
  116.  
  117.  
  118.  
  119.                                     Page 2    
  120.  
  121.  
  122.  
  123.  
  124.                            Turbo Spell User's Guide
  125.  
  126.  
  127.  
  128.  
  129.   Getting Started:
  130.  
  131.     The files needed to run Turbo Spell are 'tspell.com' and 'diction.ary'.
  132.     If  there  is  a file named 'xtraword.lst',  it should be used also.  I
  133.     recommend copying these two (or three) files onto a blank  disk  to  be
  134.     used  as  a  Turbo Spell work disk.  Alternately,  you may want to copy
  135.     them onto the disk that has your word  processing  program  on  it,  if
  136.     there is room.
  137.  
  138.  
  139.   How to run Turbo Spell:
  140.  
  141.     Turbo Spell is invoked from the DOS command line like this:
  142.  
  143.          A> TSPELL  [drive/path/filename]
  144.  
  145.     The drive/path/filename is optional.  Turbo Spell will first display an
  146.     introductory screen and wait for you to press any  key.  Then  it  will
  147.     read the dictionary into memory and create an index into it.  Next,  if
  148.     an extra word list exists,  it will be read in to memory.  If  you  did
  149.     not  specify a file to check on the command line,  you will be prompted
  150.     for a file name.
  151.  
  152.     If  you  have  given  Turbo  Spell a valid file name,  it will create a
  153.     backup copy of it,  and begin checking that file.  There must be enough
  154.     room  for the backup file on the disk.  Backup files will have the same
  155.     name as the original,  except that the last letter of the file type (or
  156.     file  name,  if  no  file  type  is  used)  will  be  replaced  with an
  157.     exclamation mark ( ! ).
  158.  
  159.     When Turbo Spell finds a word that is not in its dictionary or  in  its
  160.     extra word list, it will display a menu.  The word will be displayed in
  161.     reverse  video  above  the  menu.  The  menu will display four choices.
  162.     These are:
  163.  
  164.          1. Word is spelled correctly, continue checking
  165.          2. Word is spelled correctly, remember it, & continue
  166.          3. Word is spelled incorrectly, input correct spelling
  167.          4. Quit checking this file
  168.  
  169.     You  make  a  selection  by pressing the appropriate number key.  Let's
  170.     take a look at each of these four choices:
  171.  
  172.       1. Word is spelled correctly, continue checking:
  173.  
  174.          This selection  means  that  you  believe  the  word  is
  175.          spelled   correctly.   You  want  to  continue  checking
  176.          without saving the word to the extra words list.
  177.  
  178.  
  179.                                     Page 3    
  180.  
  181.  
  182.  
  183.  
  184.                            Turbo Spell User's Guide
  185.  
  186.  
  187.       2. Word is spelled correctly, remember it, & continue:
  188.  
  189.          This selection  means  that  you  believe  the  word  is
  190.          spelled  correctly.  You want to save the word (remember
  191.          it) in your extra word list, and then continue checking.
  192.  
  193.       3. Word is spelled incorrectly, input correct spelling:
  194.  
  195.          This selection  means  that  you  believe  the  word  is
  196.          misspelled, and you want to enter a new spelling for it.
  197.          The  word  will  be  displayed  again,  and  you will be
  198.          prompted to enter a new spelling for the word.  The word
  199.          you entered will be saved in the  text  file  and  Turbo
  200.          Spell will continue checking.
  201.  
  202.       4. Quit checking this file:
  203.  
  204.          This  selection  is  in  case  you  want  to  abort  the
  205.          checking.  Turbo Spell will stop checking and  copy  the
  206.          rest of the input file to the output file.
  207.  
  208.     When Turbo Spell is finished checking the file,  you will be  asked  if
  209.     you  would  like  to  check another.  If you answer (y)es,  you will be
  210.     prompted for another file name.  If you answer (n)o,  the program  will
  211.     save the extra word list and return you to the DOS prompt.
  212.  
  213.   How to add words to the dictionary file:
  214.  
  215.     The  words  to  be added to the dictionary file must be in a file named
  216.     'xtraword.lst'.  They must be in alphabetical order and all lower  case
  217.     letters.  The  extra  word list file that is produced by Turbo Spell is
  218.     in this format.  I recommend that you edit the file 'xtraword.lst'  and
  219.     take out the words you don't want to add to the dictionary permanently.
  220.     Don't take out the single tilde ( ~ ) on the last line of the file.  It
  221.     is  used  as  an 'end of words' marker.  This is also the time to check
  222.     the spelling of those words in a dictionary  (the  paper  kind!).  When
  223.     you add a misspelled word into the dictionary, it is there permanently.
  224.     I  suggest  keeping  a copy of your old dictionary file and extra words
  225.     list file for a while.
  226.  
  227.     If you have another list of words you want to add to the dictionary,  I
  228.     suggest  you  use  Turbo Spell on the file first.  Turbo Spell will put
  229.     them in the file 'xtraword.lst' in the proper order and format.
  230.  
  231.     The  dictionary  is  in  a  file called 'diction.ary'.  The words to be
  232.     added are in 'xtraword.lst'.  These two files,  as well as the  program
  233.     'makedict.com'  must  be  on the same disk.  Make sure there is room on
  234.     the disk for another file a bit larger than 'diction.ary',  as the  new
  235.     dictionary  will  take up more room than the old dictionary.  They will
  236.     both be present on the disk when completed.  The old dictionary will be
  237.     renamed to 'diction.old'.
  238.  
  239.                                     Page 4    
  240.  
  241.  
  242.  
  243.  
  244.                            Turbo Spell User's Guide
  245.  
  246.  
  247.     To add to the dictionary, invoke "MAKEDICT" from the command line:
  248.  
  249.          A> makedict
  250.  
  251.     A short introductory message is  displayed,  then  the  program  begins
  252.     processing  the old dictionary and the new words.  Please be patient as
  253.     this takes quite a bit of time.  A  message  will  be  printed  on  the
  254.     screen  to  tell  you  when the 'A' words are being processed,  the 'B'
  255.     words, etc.
  256.  
  257.     When it has completed,  you should copy the new  'diction.ary'  to  the
  258.     disk  where  your  old  dictionary was.  You should also delete the old
  259.     extra words list ('xtraword.lst') file on that disk since  those  words
  260.     are now a part of your permanent dictionary.  Turbo Spell will create a
  261.     new extra words list when one is needed.
  262.  
  263.  
  264.   In case of trouble:
  265.  
  266.     If  you have any problems with Turbo Spell,  I would like to hear about
  267.     them.  Please send me as much information about the problem as you can,
  268.     including but not limited to:
  269.  
  270.          1.  Any error messages displayed
  271.          2.  The number of the version of Turbo Spell that you are using
  272.          3.  The size of the current 'diction.ary' file
  273.          4.  The amount of free space left on the disk
  274.          5.  The type of computer you are using, amount of RAM, version of
  275.              DOS, etc.
  276.          6.  Any other information that might help me track down the
  277.              problem.
  278.  
  279.     If you're the first to report a real 'bug' in the program, or the first
  280.     to report a misspelled word in the dictionary,  I'll send you a copy of
  281.     the program when the problem  is  corrected.
  282.  
  283.  
  284.   Current Features/Limitations:
  285.  
  286.     - You can have a maximum of 1000 extra words in your list.
  287.  
  288.     - The current dictionary is about 9300 words.
  289.  
  290.     - Works only on ASCII files.
  291.  
  292.     - Dictionary and extra words list files must be on the default drive.
  293.  
  294.     - File to be checked can be on any drive/subdirectory.
  295.  
  296.  
  297.  
  298.  
  299.                                     Page 5    
  300.  
  301.  
  302.  
  303.  
  304.                            Turbo Spell User's Guide
  305.  
  306.  
  307.  
  308.   Future Plans:
  309.  
  310.     - Add capability to check WordStar(tm) files.
  311.  
  312.     - Increase efficiency of dictionary storage (more words in less space).
  313.  
  314.     - Add capability to handle a dictionary larger than the available RAM
  315.       through 'page' swapping.
  316.  
  317.     - Increase speed of checking.
  318.  
  319.     - Add a configuration program to allow specifying:
  320.  
  321.         * Foreground/background colors for text and menus
  322.         * Alternate drive/path location for dictionary file
  323.         * Alternate drive/path location for extra words list file
  324.  
  325.     - Add additional error checking
  326.  
  327.     - An option to search for words similar to the one that is misspelled
  328.  
  329.  
  330.  
  331.  
  332.  
  333.  
  334.  
  335.  
  336.  
  337.  
  338.  
  339.  
  340.  
  341.  
  342.  
  343.  
  344.  
  345.  
  346.  
  347.  
  348.  
  349.  
  350.  
  351.  
  352.  
  353.  
  354.  
  355.  
  356.  
  357.  
  358.  
  359.                                     Page 6    
  360.  
  361.